home *** CD-ROM | disk | FTP | other *** search
/ LSD Docs / LSD Docs.iso / FILEZ / lsd24.dms / lsd24.adf / amigavision.help.pp / amigavision.help
Text File  |  1990-09-07  |  73KB  |  1,648 lines
  1.            ____               _______________   _______________
  2.           /    \             /               \ /               \
  3.          /     /\           /                //                 \
  4.         /     /  \         /       _________//        _____      \
  5.        /     /    \       /       /        //\       /    /\      \
  6.       /     /      \     /       /        //  \      \   /  \      \
  7.      /     /        \   /        \_______//    \      \ /    \      \
  8.     /     /         /   \                \      \      \      \      \
  9.    /     /         / mUb \                \      \      \      \      \
  10.   /      \________/__   __\_________       \   __/       \_____/       \
  11.   \                  \ /                    \ /                        /
  12.    \                 //                      \\                       /
  13.     \_______________/ \______________________/ \_____________________/
  14.      \              \  \                    /  /                    /
  15.       \              \  \                  /  /                    /
  16.        \              \  \                /  /                    /
  17.         \              \  \              /  /                    /
  18.          \______________\/ \____________/ \/____________________/
  19.  
  20.                             P R E S E N T
  21.  
  22.                   A M I G A   V I S I O N   H E L P
  23.  
  24.  
  25. By PAZZA of LSD.
  26.  
  27. NOTE: These are not the full docs, but will help you to use it until
  28. the docs are available.
  29.  
  30.  
  31.                                GENERAL
  32.  
  33. SCREEN
  34.  
  35. The Screen icon allows you to present a new background picture or
  36. clear the current one. The Screen icon will also allow you to define
  37. the current screen resolution and number of colors used.
  38.  
  39. The primary use of the Screen icon is to display a picture and prepare
  40. for other audiovisual icons to be presented such as display objects
  41. and Brushes
  42.  
  43. To load a new picture, type its name in the Filename field or click on
  44. Directory to locate the picture with the file requester. After
  45. defining the filename AmigaVision will update the statistics that are
  46. associated with every picture: the resolution (high or low), number of
  47. colors (2, 4, 8, 16, 32, 64 or 4096), interlace (on or off) and
  48. overscan (on or off). These settings will reflect how the picture was
  49. saved by your paint program.
  50.  
  51. If you would like the picture to appear on the screen with a special
  52. effect, use the Transitions requester. You may use any of the
  53. transitions as long as the previous screen has the same resolution and
  54. interlace settings as the new picture, otherwise only the Fade from
  55. Black, Fade from White and NONE options may be used.
  56.  
  57. To make a transition occur when the previous picture has a different
  58. resolution or interlace setting, define a blank screen with the new
  59. picture's settings and with Transitions set to NONE. This will allow
  60. the next picture to perform any transition type.
  61.  
  62. To force a picture to appear in a resolution other than the one it was
  63. saved in, load the picture and then change the resolution, interlace,
  64. overscan and screen settings to those you wish to force the picture
  65. into. For example, if you force a Low Resolution picture to appear in
  66. High Resolution, the picture will appear in the upper left of the
  67. screen. Using the Left and Top settings you could force it to appear
  68. in the middle of the screen.
  69.  
  70. Resolution refers to the number of horizontal pixels that appear on
  71. the screen, 320 for Low Resolution, Extra Halfbrite and Hold & Modify;
  72. 640 for High Resolution. The other settings are Current, which will
  73. not change the settings for this picture and File Defined which is
  74. useful when using variables for filenames.
  75.  
  76. The number of colors is dependent on the resolution. Low Resolution
  77. screens may have 2, 4, 8, 16 or 32 colors. High Resolution screens may
  78. have 2, 4, 8 or 16 colors. Extra Halfbrite screens always have 64
  79. colors and Hold & Modify screens always have 4096 colors.
  80.  
  81. The Interlace setting refers to the number of vertical pixels that
  82. appear on the screen. On NTSC monitors, non-interlaced screens are 200
  83. pixels high and interlaced screens are 400 pixels high. On PAL
  84. monitors, non-interlaced screens are 256 pixels high, and interlaced
  85. screens are 512 pixels high.
  86.  
  87. The Overscan setting refers to the use of the border area on the
  88. monitor. Normally a picture is centered on the screen with a colored
  89. border on all four sides. Overscan screens extend into this border,
  90. making them taller and wider. Low Resolution Standard Overscan screens
  91. are 352 pixels wide and Maximum Overscan screens are 368 pixels wide.
  92. High Resolution Standard Overscan screens are 704 pixels wide and
  93. Maximum Overscan screens are 736 pixels wide in AmigaVision. NTSC
  94. Overscan non-interlaced screens are 240 pixels tall, interlaced
  95. screens 480 pixels tall. PAL Overscan non-interlaced screens are 296
  96. pixels tall, interlaced screens 592 pixels tall.
  97.  
  98. The Pointer may be either on or off. When on, the AmigaVision mouse
  99. pointer appears on the screen, when off it does not.
  100.  
  101. Clicking Adjust Palette will allow you to change the colors as defined
  102. in the picture.
  103.  
  104. After changing the palette, Modified Palette will appear as the
  105. defined palette. Current Palette keeps the palette in use before this
  106. screen icon. Original Palette uses the palette as defined in the file.
  107.  
  108.  
  109. DIGITIZED SOUND
  110.  
  111. The Digitized Sound icon allows you to play recorded sound or voice
  112. files saved in the 8SVX format. The Digitized Sound icon will also let
  113. you play the sound continuously as well as terminate the playing of
  114. other sounds.
  115.  
  116. The primary use of the Digitized Sound icon is to add real- world
  117. sounds to your presentation.
  118.  
  119. To load a digitized sound, type its name in the Filename field or
  120. click on Directory to locate the sound file with the file requester.
  121.  
  122. If you want to play the sound only one time, you do not need to change
  123. any of the other settings. To play the sound more than once, turn on
  124. the Loop setting and change the Reps setting to the number of times
  125. you wish to hear the sound. To start playing the sound continuously,
  126. turn Loop on and leave Reps set to 0.
  127.  
  128. If other sounds are already playing, or you wish to combine this sound
  129. with others, change the speaker setting from Stereo to either Left
  130. Speaker or Right Speaker. You can play multiple sounds at a time, up
  131. to four mono sounds (two on the Left Speaker and two on the Right
  132. Speaker) or one Stereo sound and one sound each on the Left and Right
  133. speaker.
  134.  
  135. If you want your presentation to continue while the sound is playing,
  136. the Pause setting must be off.
  137.  
  138. To stop a particular sound that is playing, specify its Filename and
  139. change the setting from Start to Stop. You can stop all the sounds
  140. currently playing by selecting Stop All.
  141.  
  142. You may also change how loud the sound is played. The maximum Volume
  143. setting of 64 will play the sound as loud as the volume of your
  144. speakers is set. Lower values will play the sound softer. If you want
  145. to overlay some digitized voice with a theme song, set the theme's
  146. Volume low and keep the speech at the maximum setting.
  147.  
  148.  
  149. SYNTHESIZED SPEECH
  150.  
  151. The Synthesized Speech icon allows you to use the Amiga's internal
  152. voice. The Synthesized Speech icon will speak text typed into the
  153. requester or a file of text, and will also allow you to stop text that
  154. is being read.
  155.  
  156. The Synthesized Speech icon is used to inform the user, read text or
  157. merely to make certain aspects of your presentation stand out.
  158.  
  159. If you want to speak just a few words or a short sentence or two, type
  160. your message in the field below the Text String gadget. This message
  161. can be up to 255 characters long.
  162.  
  163. To specify a file of text to read, switch from Text String to
  164. Filename, and type the name of the file in the Filename field or click
  165. on Directory to locate the file with the file requester. You can imbed
  166. a number of speech effects in file to change the sound of the voice.
  167.  
  168. When using a text file and imbedding speech codes, you will want to
  169. turn off the Enable gadget which, when on, will override the speech
  170. effects in the file.
  171.  
  172. The Pause button specifies if the presentation should continue while
  173. the text is being read.
  174.  
  175. When you don't Pause, the speech will continue for the length of text
  176. provided. If you wish to stop the speech at some point, switch the
  177. gadget from Start to Stop.
  178.  
  179. There are a number of settings that affect the voice: the gender, Male
  180. or Female; the sound channel, Stereo, Left Speaker or Right Speaker,
  181. allowing you to combine speech with digitized sound; style of voice,
  182. Natural or Robotic; Volume, where 64 is the maximum setting and lower
  183. values will make the speech softer; Pitch which affects tone of the
  184. voice from lower to higher; and Rate which is the speed at which the
  185. text is read, from slower to faster.
  186.  
  187.  
  188. MUSIC
  189.  
  190. The Music icon allows you to play music saved in the SMUS format. The
  191. Music icon will let you play the music continuously as well as
  192. terminate music being played.
  193.  
  194. To specify the song to play, type its name in the Filename field or
  195. click on Directory to locate the music with the file requester.
  196.  
  197. You also need to specify where the instruments for the music are
  198. stored by specifying the path in the Instrument Path field.
  199.  
  200. If your music file was written to play on a MIDI instrument, turn MIDI
  201. on. AmigaVision supports four MIDI channels.
  202.  
  203. If you want your presentation to continue while the music plays, turn
  204. Pause off. If at a later point you wish to stop the music, add another
  205. Music icon and change Start to Stop.
  206.  
  207. To have the music play more than once, set Loop on. If you wish it to
  208. repeat continuously (or until a Stop appears in the presentation),
  209. leave Reps set to 0, otherwise specify the number of times to repeat
  210. the music file.
  211.  
  212. You may also change how loud the music is played. The maximum Volume
  213. setting of 64 will play the music as loud as the volume of your
  214. speakers is set. Lower values will play the music softer.
  215.  
  216.  
  217. GRAPHICS
  218.  
  219. The Graphics icon allows you to place display objects on the screen,
  220. add hit boxes and change color cycling effects of screens. The
  221. Graphics icon will also let you stamp display objects onto screens.
  222.  
  223. The primary use of the Graphics icon is to add display objects to
  224. still pictures for user input, as well as to make use of the Amiga's
  225. color cycling animation effects.
  226.  
  227. To modify display objects with the Object Editor, click Object Editor.
  228.  
  229. If you want to stamp the display objects onto the screen, turn on
  230. Background. These objects will remain until something overlays them,
  231. such as a new Screen or new Graphics or Brushes.
  232.  
  233. Color cycling effects are controlled by the four multi-state gadgets,
  234. each of which represents a different color cycling range. Each range
  235. has four possible states: n/c, which will not change the current
  236. setting; forward, which will MANXe that range forward; reverse, which
  237. will cycle that range backward; and off, which turns off color cycling
  238. for this range.
  239.  
  240.  
  241. BRUSH
  242.  
  243. The Brush icon allows you to add brushes and full pictures onto an
  244. existing screen. The Brush icon will also allow the brush to be placed
  245. with a special effect transition.
  246.  
  247. To specify the brush, type its name in the Filename field or click on
  248. Directory to locate the brush with the file requester. Brushes can be
  249. of any resolution, but they will be distorted if they are not in the
  250. same resolution and number of colors as the current screen.
  251.  
  252. If you wish to switch to the brush's palette instead of the current
  253. screen's palette, change Current Palette to Override Palette.
  254.  
  255. If you wish color 0 in the brush to be transparent, turn Cookie Cut
  256. on.  This allows the image behind the Brush to be visable wherever
  257. color 0 is present.
  258.  
  259. If you wish to place the brush in a particular spot on the screen, you
  260. must set the Left and Top value.  These refer to the number of pixels
  261. to offset the brush from coordinates 0, 0. For example, if you wish to
  262. place a brush near the center of a Low Resolution screen, Left would
  263. be 160 and Top would be 100 (half of 320 and 200).
  264.  
  265. To have the brush appear with a special effect, choose Transitions and
  266. specify the one you wish.
  267.  
  268.  
  269. VIDEO
  270.  
  271. The Video icon allows you to add videodisc effects to your
  272. presentation.
  273.  
  274. You specify the action you wish to take place in the list that appears
  275. below the Controller gadget. Click Controller if you wish to use the
  276. Videodisc Controller to search out frames and test different settings.
  277.  
  278. The two parameters, Param 1 and Param 2 are used with certain
  279. controller commands. For example, Play requires both a start frame and
  280. an end frame.
  281.  
  282. If you want your presentation to continue while the videodisc is in
  283. use, turn Pause off.
  284.  
  285. The four multi-state gadgets affect how the videodisc is used in terms
  286. of Video, Audio and the Index feature. The three settings are: n/c,
  287. which doesn't change the current setting; on, which enables that
  288. feature; and off, which disables that feature. Not all videodisc
  289. players support all these features. For example, some players do not
  290. allow you to turn the video off.
  291.  
  292.  
  293. ANIMATION
  294.  
  295. The Animation icon allows you to play back animations that are saved
  296. in the ANIM OPT 5 format. The Animation icon can also create a new
  297. screen for the animation as well as play it continuously.
  298.  
  299. To specify the animation, type its name in the Filename field or click
  300. on Directory to locate the animation with the file requester.
  301.  
  302. Normally the animation will play on a new screen with its own colors.
  303. If you want to play the animation on an existing screen, turn Override
  304. Screen off. Once off you can change the color gadget from Override
  305. Palette which uses the palette of the animation to Current Palette
  306. which uses the current screen's palette.
  307.  
  308. If you want your presentation to continue while the animation plays,
  309. turn Pause off.
  310.  
  311. To play the animation more than once, turn Loop on. If Reps is left at
  312. 0 the animation will play continuously until a new screen is
  313. displayed. You can change the value of Reps to specify the number of
  314. times to repeat the animation.
  315.  
  316. If you wish to offset the animation on the screen, change the values
  317. of Left and Top which affect where the animation is played relative to
  318. coordinate 0, 0.
  319.  
  320. You may also have the first frame of the animation appear on the
  321. screen using a special effect transition. Click Transitions to specify
  322. the effect.
  323.  
  324.  
  325. TEXT FILE
  326.  
  327. The Text File icon allows you to display ASCII text on the screen in a
  328. window. The Text File icon will also allow you to specify the point in
  329. the file at which to begin displaying the text.
  330.  
  331. The primary use of the Text File icon is to allow the user to read a
  332. body of information at his/her own pace.
  333.  
  334. To specify the text file, type its name in the Filename field or click
  335. on Directory to locate the text file with the file requester.
  336.  
  337. Use the Object Editor to specify the location of the text file and the
  338. gadgets for viewing the file. To allow the user to scroll through the
  339. text you can add up to five hit boxes with the following response
  340. strings: lineup scrolls the text up one line; linedown scrolls the
  341. text down one line; pageup advances the text up the number of lines
  342. equal to the number of lines displayed in the text window at any one
  343. time; pagedown does the same but in the downward direction; quit
  344. terminates the Text File icon.
  345.  
  346. If you want to start displaying the text from a particular string in
  347. the file, click the String gadget and specify the text to search for.
  348. The text will then begin displaying from the first occurrence of that
  349. string.
  350.  
  351. If you want the text window to disappear after a certain amount of
  352. time rather than having the user click on a quit box, alter the value
  353. of Timeout to be greater than 0.
  354.  
  355.  
  356.                           AMIGA VISION WAIT
  357.  
  358. GROUPED WAIT
  359.  
  360. The Grouped Wait icon combines multiple wait icons.
  361.  
  362. Click on the Timeout gadget to specify the amount of time in seconds
  363. the presentation will wait in the event the desired response does not
  364. occur. If the Timeout is set to 0 (the default), the program waits for
  365. an infinite time. If Timeout is greater than 0, the program waits the
  366. specified number of seconds.
  367.  
  368. Note that the Timeout specified for the Grouped Wait overrides any and
  369. all timeout settings on the individual children Wait icons.
  370.  
  371. Click on the multi-state gadget below Timeout to choose either AND or
  372. OR. If Logically AND children icons is specified, the presentation
  373. will wait until all of the children's responses occur (in no specific
  374. order). If Logically OR children icons is selected, the presentation
  375. waits for only one of the children's responses to occur.
  376.  
  377.  
  378. WAIT CONDITION
  379.  
  380. The Wait Condition icon causes your presentation to wait for a
  381. particular expression to be true before continuing. For example you
  382. could wait for a variable to reach a certain value.
  383.  
  384. Click on the Timeout gadget to specify the amount of time in seconds
  385. the presentation will wait in the event the desired response does not
  386. occur. If the Timeout is set to 0 (the default), the program waits
  387. infinitely. If Timeout is greater than 0, the program waits the
  388. specified number of seconds.
  389.  
  390. Click on the Expression Editor gadget to enter the Expression Editor
  391. where you specify the conditional expression. The text box under the
  392. Expression Editor gadget  displays the expression you create.
  393.  
  394.  
  395. WAIT KEYBOARD
  396.  
  397. The Wait Keyboard icon allows you to pause your presentation until a
  398. certain key or one of a group of keys is pressed.
  399.  
  400. Click on the Timeout gadget to specify the amount of time the
  401. presentation will wait in the event the desired response does not
  402. occur. If the Timeout is set to 0 (the default), the program waits
  403. infinitely. If Timeout is greater than 0, the program waits the
  404. specified number of seconds.
  405.  
  406. Click in the Key(s) field and type in the specific key or keys to be
  407. pressed. If you want to allow more than one key as possible
  408. alternatives, separate them by commas. For example, you want the user
  409. to choose from a menu of five items by pressing one of the five
  410. numbers. The key field would appear as: "1,2,3,4,5". For characters
  411. the user input is case sensitive; i.e. you can specify the characters
  412. "A" and "a" as two separate keys. To wait for the Help, Esc or
  413. function keys, spell them out as they appear on the keyboard.
  414.  
  415. The key pressed by the user is stored and can be checked using the
  416. response() function in the Expression Editor. For instance, after a
  417. keyboard input you want to branch using an If-Then-Else icon, then you
  418. will use the response() function. If you double-click the If-Then-Else
  419. icon, you will be presented the Expression Editor, where you enter the
  420. following type of expression:
  421.  
  422.          response() == "A" or response() == "a"
  423.  
  424. The appropriate branching action can be specified if this response
  425. function returns a TRUE (see If-Then-Else icon section for more
  426. details).
  427.  
  428. The Any Key option, when set to on, causes the presentation to wait
  429. for any key press on the keyboard before continuing to the next icon
  430. in the flow. For example, you may want to provide a feature that
  431. pauses an application so that a user can take a break. When the user
  432. returns to the application he can continue with the application by
  433. pressing any key on the keyboard.
  434.  
  435. Exclusive, when set to On means that only the keys specified by this
  436. icon will be active. Other keys that may have been defined previously
  437. will not be active during this wait. When Exclusive is set to off,
  438. then previously defined hit boxes, keyboard interrupts, etc. will all
  439. be active. The user can select any of them. If you want to have
  440. interrupts active throughout the application, do not set Exclusive On.
  441.  
  442. Click on the Object Editor gadget to enter the Object Editor. Here you
  443. may create text and other display objects for placement on the screen
  444. during the wait. For instance, using the objects you might want to
  445. display a text string informing the user "Press Any Key to Continue."
  446.  
  447. You can set the Auto Remove gadget to the On or Off state. If it is On
  448. (default), then the objects and text (created in the Object Editor)
  449. associated with the Wait Keyboard icon will disappear when the desired
  450. response is given by the user. If it is off, the objects and text
  451. remain on the screen until the action of all its siblings are
  452. completed.
  453.  
  454.  
  455. WAIT MOUSE
  456.  
  457. The Wait Mouse icon allows you to pause your presentation until a
  458. particular "hit box" is clicked.
  459.  
  460. Click on the Timeout gadget to specify the amount of time in seconds
  461. the presentation will wait in the event the desired response does not
  462. occur. If the Timeout is set to 0 (the default), the program waits
  463. infinitely. If Timeout is greated than 0, the program waits the
  464. specified number of seconds.
  465.  
  466. When Any Click is On, it causes the presentation to wait for a mouse
  467. click before continuing. All mouse clicks are assumed to be the click
  468. of the left mouse button. During presentation the right button on the
  469. mouse is not checked for by AmigaVision.
  470.  
  471. When Exclusive is On, it means that only the hit boxes specified by
  472. this icon will be active. All the other hit boxes, including
  473. interrupts,  that may have been defined previously will not be active
  474. during this wait. Thus if you want your interrupts to be active set
  475. the Exclusive gadget to Off state.
  476.  
  477. When the Auto Remove gadget is set to the On state (default), the
  478. objects and text associated with the Wait Mouse icon (created in the
  479. Object Editor) will disappear when the desired response is given by
  480. the user. If it is not selected, the objects and text remain on the
  481. screen until the actions of all its siblings are completed.
  482.  
  483. Click on the Object Editor gadget to enter the Object Editor. Here you
  484. may place text or objects on the screen to create the appearance of
  485. the wait and define the hit boxes and response strings.
  486.  
  487. You create text hit boxes for the menu in the Object Editor using the
  488. Add-Text/Variable option. You must type a response string  in the
  489. requester to use the text object as a hit box.
  490.  
  491.  
  492. DELAY
  493.  
  494. The Delay icon is used to cause your presentation to pause for a
  495. specified number of seconds before continuing.
  496.  
  497. Click on the Delay field to specify the amount of time to wait. Note
  498. that if you set the time to 0 seconds, which is the default value, the
  499. Delay icon causes a pause of infinite duration. You must specify a
  500. positive value for pauses of finite duration.
  501.  
  502.  
  503.                             USER INTERFACE
  504.  
  505. KEYBOARD INTERRUPT
  506.  
  507. Use the Keyboard Interrupt icon to define specific keys such as
  508. function keys which, when pressed during the presentation of an
  509. application, will cause an interrupt. You may define a keyboard
  510. interrupt which is active through the entire application or only for a
  511. part of it.
  512.  
  513. Click in the Key(s) field and type in the key(s) which will be used to
  514. cause the interrupt. If special keys (e.g., function keys, Help key or
  515. the Esc key) are to be used, type the name of the key as it appears on
  516. the keyboard in this field.  The available special keys are F1 through
  517. F10, Esc, Space and Help. For the arrow keys you can enter Up, Down,
  518. Right and Left. Type Enter, Return and Tab to specify these respective
  519. keys as interrupt keys.
  520.  
  521. Key combinations such as Ctrl-A or Alt-F  or the Right-Amiga keys are
  522. not supported.
  523.  
  524. If you wish to have multiple interrupt keys defined for the same
  525. interrupt, then separate the keys by commas in the key definition
  526. field. For instance, you can type in F1, Help, Esc to specify that all
  527. three keys enable the same interrupt.
  528.  
  529. Click on the Object Editor gadget to open the Object Editor where you
  530. may create text or objects to be placed on the screen with the
  531. interrupt. For instance, you might want to inform the user "Press Help
  532. key for additional help or Esc key to exit." You can do this by using
  533. text objects. These objects are uniquely associated with the
  534. interrupt, and whenever the interrupt is active they will appear on
  535. the screen.
  536.  
  537.  
  538. MOUSE INTERRUPT
  539.  
  540. The Mouse Interrupt icon is used to define areas on the screen called
  541. hit boxes which, if clicked on, will cause an interrupt in the flow.
  542. You may define a mouse interrupt which is active through the entire
  543. application or only a part of it.
  544.  
  545. Click on the Object Editor gadget to open the Object Editor. Here you
  546. may create text or objects to be used as hit boxes with the interrupt.
  547. These objects are uniquely associated with the interrupt, and they
  548. will be placed on the screen if the interrupt is active.
  549.  
  550.  
  551. REMOVE
  552.  
  553. The Remove icon removes interrupts at its own level (or the same
  554. vertical column in the flow). You may use the Remove icon to disable
  555. either the last interrupt or all of the interrupts which are siblings
  556. to the Remove icon.
  557.  
  558. If used inside an interrupt, the Remove icon will have no effect.
  559.  
  560. Click on the Remove All/Last interrupt(s) multi-state gadget to select
  561. the appropriate action. The All option removes all interrupts that
  562. have been defined prior to the Remove icon and which appear on the
  563. same level as the Remove icon.  The Last option removes the most
  564. recent interrupt defined prior to the Remove icon on the same level as
  565. the Remove icon.
  566.  
  567.  
  568.                               REQUESTER
  569.  
  570. SPECIFY VALUE
  571.  
  572. The Specify Value requester is used when a numerical value is needed.
  573.  
  574. The Specify Value requester is used to enter a numeric value; for
  575. example, a video frame number or the number of times a loop will run.
  576. The Specify Value requester opens when you click on a field requiring
  577. a numeric value. The value may be an actual number or a variable and
  578. may be entered using one of the following three methods:
  579.  
  580. 1. Type the desired number or variable name into the field at the top
  581. of the requester.
  582.  
  583. 2. Click on the number gadgets to enter the value into the field.
  584.  
  585. 3. Click on a variable name from the list at the right. The list
  586. contains all of the variables defined for the current position in the
  587. outline.
  588.  
  589. You may exit the requester by one of the following methods:
  590.  
  591. 1. To retain the value, click on the OK gadget or press the Enter key
  592. on your keyboard.
  593.  
  594. 2. To ignore any changes made, click on the Cancel or Close Window
  595. gadget.
  596.  
  597.  
  598. REFERENCING
  599.  
  600. There are two Referencing requesters. They are used to reference an
  601. icon which appears elsewhere in the outline. The first is presented
  602. when you click on the placeholder icon (the placeholder icon appears
  603. when one of the following icons is placed in the outline:  Goto,
  604. Conditional Goto or Call). The second Referencing requester opens when
  605. you have selected the icon you wish to reference.
  606.  
  607. The Goto, Conditional Goto and Call icons require a partner which is a
  608. reference to another point in the outline. When you place one of these
  609. icons into the outline, a Placeholder icon appears.
  610.  
  611. 1.  To begin the referencing process, double-click on the Placeholder
  612. icon. This opens a requester which asks "Begin reference icon
  613. specification?"
  614.  
  615. -  Click on OK to begin the referencing process.
  616.  
  617. -  Click on Cancel to abort the selection process.
  618.  
  619. 2.  Next, move around in the Flow Window to find the icon you wish to
  620. reference and double-click on it. A second requester is presented. You
  621. will be prompted "Reference this icon:"
  622.  
  623. -  Click on OK to choose the selected icon as the reference. The
  624. reference icon will then replace the Placeholder icon.
  625.  
  626. -  Click on Continue to search for a different reference icon.
  627.  
  628. -  Click on Cancel to end the referencing process.
  629.  
  630. After you have completed the process, the referenced icon will appear
  631. beside its partner, as well as in its original location in the
  632. outline.
  633.  
  634.  
  635. TRANSITIONS
  636.  
  637. The Transitions requester is used to define the transitional screen
  638. between pictures. It is presented when you click on the Transitions
  639. gadget in an icon requester.
  640.  
  641. The Transitions requester is offered as an option in the requesters
  642. for Screen, Brush and Animation icons. It allows you to select one of
  643. several transitional screen patterns. A transition pattern is what the
  644. user will see when the screen moves from one picture, brush or
  645. animation sequence to another.
  646.  
  647. Select the desired transition by clicking on its name in the list.
  648.  
  649. Use the Speed gadget to specify the speed at which the transition
  650. occurs. Click on it to change the mode from Normal to Fast to Slow.
  651.  
  652. After specifying the transition and the speed, click on the OK button.
  653. You will return to the icon requester. The transition you have chosen
  654. will appear in the icon requester in the field next to the Transitions
  655. gadget.
  656.  
  657.  
  658. SEARCH
  659.  
  660. The Search option helps you locate an icon by name. When you choose
  661. this option a requester is presented. You can click on the Icon List
  662. gadget to get a list of all the icon names in that window. You can
  663. select a name and the flow window will display icons centered around
  664. that one. Also, that icon will be in a selected state.
  665.  
  666. You can also type the name of the icon in the field to bypass the
  667. list. In this field you can use the wildcard characters * and ? if you
  668. do not remember the exact name of the icon to which you want to
  669. search. The ? is used to represent a single character and the * is for
  670. one or more characters. For instance, if you vaguely recall the icon
  671. name as starting with "St" and with the second to the last character
  672. being the letter "r", then you can type in the field a name such as
  673. "St*r?". This will locate an icon if the name matches only with the
  674. given characters.
  675.  
  676. If an icon is selected when you choose search, you can use the multi-
  677. state gadget to specify the location in your flow from which to start
  678. the search. You can choose From Selected or From Top. The former will
  679. search from the currently selected icon and the latter will search
  680. from the starting icon in the application.
  681.  
  682. It is a good practice to name the icons as soon as you use them. This
  683. way when the application gets very large, you can locate various
  684. icons. The Search option will not work without icon names.
  685.  
  686.  
  687. PRINT
  688.  
  689. The Print option prints out the information in the outline of your
  690. application in the currently selected edit window.
  691.  
  692. Click on the multi-state gadget to select the output destination:
  693. Print to Printer or Print to File. If you choose File, type the name
  694. of the file in the filename field  or click on the Directory gadget to
  695. open the File requester. Here you may choose a filename or create a
  696. new one for the output. If you choose the Printer option then make
  697. sure your printer is connected to your computer, it is turned on and
  698. has paper for printing.
  699.  
  700. If you choose the Printer option use the multi-state gadget to specify
  701. whether you want Text or icon Image printed. If you select Text the
  702. name and the memo fields will be printed, and if you select Image the
  703. icon images and names will be printed. In both cases the printing will
  704. be in the same flow sequence as seen in the flow editor.
  705.  
  706. You may print either a selected icon or the entire outline.  To print
  707. one icon, select it before choosing the Print menu option.  If there
  708. are no selected icons, AmigaVision prints the entire outline.
  709.  
  710. The names of the icons will be printed.  If you wish to print the memo
  711. fields as well, set the Memo gadget to ON by clicking on it, so that
  712. it is checked.
  713.  
  714. When you click on OK, AmigaVision starts printing.
  715.  
  716. If you want to abort printing and exit the print requester click on
  717. Cancel.
  718.  
  719.  
  720. APPLICATIONS CREATE DISKETTE(S)
  721.  
  722. The Applications option has two submenu items-- Create Diskette(s) and
  723. Install / Relocate. The Create Diskette(s) option helps install a
  724. finished application on disks for duplication and use.
  725.  
  726. An AmigaVision application may consist of the flow file, the
  727. audiovisual files, the database files, fonts and instruments. The
  728. Applications options help install these files.
  729.  
  730. When you select the Create Diskette(s) option, the Application
  731. Diskette Creation requester is presented.
  732.  
  733. 1. Click on the Directory gadget to open the File requester.  Then
  734. specify the name of the application you wish to use. The name will
  735. appear in the Filename field.
  736.  
  737. 2. Next, click on then Course Name field.  Type in the name for the
  738. application.  This does not need to be the same as the Filename.
  739.  
  740. 3. Select Edit Protect to protect the application from editing.  The
  741. user will be able to run the presentation but will not be able to view
  742. the icon structure in a Flow Window.
  743.  
  744. 4. Specify the drives for copying the application to the disk(s)
  745. (DF0:-DF3:).
  746.  
  747. 5. Click on OK to start the creation process. Click on Cancel to exit
  748. the requestor without creating a diskette.
  749.  
  750. AmigaVision will tell you how many diskettes it will need for your
  751. application. If one disk becomes full during the creation process,
  752. AmigaVision will prompt you for the next disk. The disks will also be
  753. labelled in the order that they are copied.
  754.  
  755. You cannot install more than one application on the same disk, as the
  756. disks are named with the name of the application.
  757.  
  758. When the Applications option creates the diskettes it copies all
  759. audiovisual and database files referenced in your application. It
  760. installs them in their proper directories and modifies the application
  761. to reference the new path names and directories. If a filename is
  762. specified as a variable then the Applications option does not copy a
  763. file. It simply creates a Log file on the application disks. The Log
  764. file also consists of a list of instruments for music playback and any
  765. non-standard fonts referenced in your application. Some instruments
  766. and fonts are proprietary, you need to be careful copying these into
  767. an application intended for commercial use. You are responsible for
  768. distributing any copyrighted material. Please read the Log file by
  769. clicking on the View .log file gadget for a list of all the non-
  770. installed resources such as picture files, instruments and fonts. The
  771. Log file is in ASCII format.
  772.  
  773. In the case of instruments, you can install them on the distribution
  774. diskettes by loading them in your application using a Resource icon
  775. (see Chapter 6). The Create Diskette(s) option will then install these
  776. instruments on the application diskettes rather than listing them in
  777. the Log file.
  778.  
  779.  
  780. APPLICATIONS INSTALL/RELOCATE
  781.  
  782. The Applications option has two submenu items: Create Diskette(s) and
  783. Install / Relocate.  The Install / Relocate option helps you to
  784. install an application from a distribution disk to your hard disk or
  785. from one directory on your hard disk to another. When you choose this
  786. option the Application Install/ Relocate requester is presented. You
  787. must specify the application Source Filename, the Destination
  788. Filename, and the specific paths for animation, ILBM (picture), SMUS
  789. (music), 8SVX (digitized sound) and other Miscellaneous files.  Your
  790. application will be installed in the destination directory. Your flow
  791. file will be automatically modified to reflect the changes in file
  792. directories. Using this option you can move applications between disk
  793. drives or between directories.
  794.  
  795.  
  796. DEFAULTS
  797.  
  798. The Defaults options specify, for each application, a set of default
  799. parameters that will be saved with the application. If you are editing
  800. different applications in different edit windows, you can specify
  801. separate defaults for each of the window.
  802.  
  803. You can set the edit Window Grid gadget to "ON" (default) if you want
  804. a grid displayed on top of your edit window. This grid can be helpful
  805. in giving visual alignments in placing icons in the outline.
  806.  
  807. Click the Double Buffering gadget to "ON" if you want animation
  808. playback to use double buffers, i.e., load two consecutive images into
  809. memory. This reduces delays in screen update.
  810.  
  811. Standard Overscan uses screen widths of 352 for Low Resolution and 704
  812. for High Resolution. If the overscan pictures on your monitor or
  813. display do not reach both the left and right edges of the monitor,
  814. switch to Maximum Overscan which uses 358 pixels for Low Resolution
  815. and 736 for High Resolution. Note: when using a Multiscan monitor that
  816. can display more than 736 horizontal pixels, overscan will never
  817. completely cover the display. Maximum Overscan is used primarily to
  818. record Amiga graphics to a VCR with a genlock; since television sets
  819. and professional video monitors generally need more horizontal pixels
  820. than Standard Overscan provides in order to fill the screen.
  821.  
  822. Set the Close Workbench gadget to ON if you want to save memory by
  823. closing down the Workbench screen during a presentation. The Workbench
  824. screen will be closed only if no other application is using the
  825. screen. For example, if you have a CLI window open, AmigaVision will
  826. not be able to close down the Workbench.
  827.  
  828. There are four fields to specify defaults for: Instrument Path,
  829. Initial Screen File, Feedback Sound for hit boxes and Audio Volume.
  830.  
  831. The Default Instrument Path specifies the path name for locating the
  832. instrument files for playback with SMUS music files. In the Music icon
  833. you have the option of overriding the default setting.
  834.  
  835. The Initial Screen File selects a picture file to be displayed at the
  836. start of the presentation of an application. It is a good practice to
  837. specify an introductory picture file, or the application will start
  838. off with a blank screen in the default high-resolution mode with the
  839. four Workbench colors.
  840.  
  841. The default Feedback Sound is the name of the digitized sound file
  842. that you want to playback as a feedback for objects or hit boxes
  843. created using the Object Editor.
  844.  
  845. The default Audio Volume is an index in the range of 0 to 64 for
  846. specifying the default volume of all the sound files: digitized audio,
  847. music and speech. In the icons that control these sounds you have the
  848. option of overriding the default setting
  849.  
  850. This option cannot be used to control the audio from the two channels
  851. of videodisc player models without volume control through software.
  852. The volume control feature is to help you select a volume for sounds
  853. from the computer consistent in volume with the audio level from the
  854. videodisc player.
  855.  
  856.  
  857. PREFERENCES
  858.  
  859. The Preferences requester allows you to select the language
  860. AmigaVision uses, and the formats for date and numerical values. These
  861. settings take affect when 'OK' is selected and are stored in the file
  862. S:AV.prefs for use the next time AV is executed.
  863.  
  864. The requester displays all languages currently present in the AV_Help
  865. and AV_Text subdirectories. To select one of the displayed languages,
  866. click on it in the list. If the language you desire is not present,
  867. simply copy its files from the appropriate language disk to the
  868. appropriate AV_Help or AV_Text drawer. After adding new languages
  869. close and reopen the Preferences requester to allow selecting from the
  870. list.
  871.  
  872. To select any of the date formats displayed, simply click on the
  873. appropriate list entry.
  874.  
  875. Two numeric formats are supported, and are selected by clicking on the
  876. multi-state gadget until the desired format is shown.
  877.  
  878. Pressing OK stores the information to disk and causes any needed
  879. language change to be made. Selecting Cancel aborts the preferences
  880. selection and retains the previous settings.
  881.  
  882.  
  883.                                 MODULE
  884.  
  885. MODULE
  886.  
  887. The Module icon is the primary way to group other icons. The Module
  888. icon serves as the parent for other icons and can also define "local"
  889. variables that will remain active within the Module.
  890.  
  891. The Delete, Insert and Move gadgets are used to arrange expressions
  892. that define local variables in the window to the left of these
  893. gadgets. When you click on Insert, the Expression Editor is presented
  894. for you to define variable expressions. Here you can define one or
  895. more variables. All definitions are assumed to be new variables. When
  896. you exit the Expression Editor by clicking on OK, the expressions will
  897. appear in the window in the Module requester.
  898.  
  899. To insert expressions in a particular place in the list of existing
  900. expressions in the window, click on the expression below the line
  901. where you wish to insert the new expression and click on Insert.
  902.  
  903. To delete a variable definition from the list, click on the expression
  904. defining the variable displayed inside the window. Then click on
  905. Delete.
  906.  
  907. To move an expression elsewhere in the list, click on it and then
  908. Click on the Move gadget. To move an expression above its original
  909. position, click on the expression above the line where you want to
  910. move it to. Similarly, to move an expression below its original
  911. position, click on the expression below the line where you want to
  912. move it to.
  913.  
  914. Double-clicking on an expression presents the variable and the
  915. associated expression in the Expression Editor for editing.
  916.  
  917.  
  918. SUBROUTINE
  919.  
  920. The Subroutine icon is used to group icons that represent frequently
  921. used procedures. It can be called from multiple locations by the main
  922. presentation using the Call icon. It is also useful in defining
  923. "local" variables that are valid only within the subroutine.
  924.  
  925. The Delete, Insert and Move gadgets in the requester are used to
  926. arrange expressions in the expressions window to the left. When you
  927. click on Insert, the Expression Editor is presented and you may define
  928. variables. When you exit the Expression Editor by clicking on OK, the
  929. expressions will appear in the expressions window.
  930.  
  931. To insert expressions in a particular place in the list of existing
  932. expressions in the window, click on the expression below the line
  933. where you wish to insert and click on the Insert gadget.
  934.  
  935. To delete an expression from the list, click on the expression. Then
  936. click on the Delete gadget.
  937.  
  938. To move an expression elsewhere in the list, click on the expression.
  939. Then click on the Move gadget. To move an expression above its
  940. original position, click on the expression above the line where you
  941. want to move it to. To move an expression below its original position,
  942. click on the expression below the line where you want to move it to.
  943.  
  944. Double-clicking on an expression presents it in the Expression Editor
  945. for editing.
  946.  
  947. Frequently, you may call a subroutine from a point in the application
  948. flow which has a screen background along with display objects that
  949. were placed on the background by various icons. If your subroutine
  950. modifies the screen, be sure to return the screen to its original
  951. state when the subroutine is completed. You can do this by storing the
  952. background image filename in a variable and using it inside the
  953. subroutine for returning the screen to its state at which the
  954. subroutine was called.
  955.  
  956. In the case of display objects that are on the screen at the time the
  957. subroutine was called, you can use the multi-state gadget to either
  958. not remove or temporarily remove all of them. Temporarily means that
  959. the objects will be removed until the subroutine is completed and they
  960. will then be reactivated.
  961.  
  962.  
  963. QUIT
  964.  
  965. The Quit icon ends the presentation or course. It returns the user to
  966. either the AmigaVision Editor or Workbench screen depending on how the
  967. application was started. If it was started from the Flow Editor, it
  968. will return control to the Flow Editor. Alternatively, if the
  969. application was started from its icon, then control will be returned
  970. to Workbench.
  971.  
  972.  
  973. RETURN
  974.  
  975. The Return icon is used in conjunction with the Subroutine icon. When
  976. the Return icon is encountered, the application exits the subroutine
  977. and continues with the icon following the Call icon in the outline
  978. which called the subroutine.
  979.  
  980. If no Return is placed as a child to the Subroutine, the Subroutine
  981. will execute completely and then automatically return to the icon
  982. following the Call icon.
  983.  
  984. As one example, you may want to place the Return inside a Subroutine
  985. as a partner to a conditional icon. If the condition is true, the
  986. Return will be executed. If the condition is false, the Subroutine
  987. will continue executing.
  988.  
  989. If a Return icon is encountered and there has been no Call, the
  990. application will exit as if it encountered a Quit icon. You have to be
  991. careful in the design of your application to be sure that a subroutine
  992. is not executed except by a Call icon. For instance, if you have a
  993. Module icon followed by a Subroutine icon without a Quit icon in
  994. between the two, the subroutine will be executed as if it were another
  995. module and the application will exit if it encounters a Return
  996. B icon.
  997.  
  998.  
  999. EXECUTE
  1000.  
  1001. The Execute icon is used to call programs external to AmigaVision. You
  1002. can use it to allow the user to open a text editor or a paint program,
  1003. or to call a supplemental program for your presentation. It also lets
  1004. you launch an ARexx script if you want to have another program
  1005. exchanging information with AmigaVision.
  1006.  
  1007. The Directory gadget opens the file requester where you specify the
  1008. filename of the external program. You may also click on the Filename
  1009. field and type in the name of the file to be referenced.
  1010.  
  1011. You must specify the screen to be displayed while the external program
  1012. is executing. The choices are Custom and Workbench. Select the Custom
  1013. option if the external program uses a custom screen. If not, you
  1014. should choose the Workbench option.  These two options help
  1015. AmigaVision manage the display screens properly. For instance, if your
  1016. external program runs on the Workbench screen, then AmigaVision will
  1017. display the Workbench screen and move the AmigaVision application
  1018. screen to the background so that it is hidden from the viewer.
  1019.  
  1020. You must also specify the mode of program execution. The Mode options
  1021. are Workbench, ARexx, and CLI.
  1022.  
  1023. The Workbench option assumes that the external program will be loaded
  1024. into memory from the Workbench by simulating the double-click of left
  1025. mouse button on the Workbench icon. Sometimes a program has options
  1026. that can be set within the Tool types field of its icon (to set
  1027. graphics mode, default settings, etc.). Using the Workbench option
  1028. allows you to take advantage of this.
  1029.  
  1030. The ARexx mode indicates that you are executing an ARexx script. An
  1031. important note: the ARexx interpreter must be active before you can
  1032. send any scripts to it. If ARexx is not active, any Execute icons in
  1033. ARexx mode will be ignored.
  1034.  
  1035. The ARexx mode allows you to select variables for saving the Return
  1036. Code and Result values returned by ARexx. The Return Code (RetVal)
  1037. indicates how successful ARexx was at executing your script. Please
  1038. refer to the ARexx documentation for the meaning of the Return Codes.
  1039. The Result is the value that ARexx returns to AmigaVision. Please
  1040. refer to Appendix B for more information about AmigaVision's ARexx
  1041. interface.
  1042.  
  1043. The CLI option executes the commands in the string gadget as if they
  1044. were typed directly into a CLI window. This means you can also include
  1045. command line settings in the string.
  1046.  
  1047.  
  1048. TIMER
  1049.  
  1050. The Timer is like a stopwatch. When started, it begins counting
  1051. elapsed time. When you stop the timer, it retains the elapsed time. If
  1052. you restart the timer again, it continues counting from where it left
  1053. off. If you want it to start counting from zero again, then you must
  1054. choose the Start option instead of Restart.
  1055.  
  1056. You may have up to nine timers running simultaneously. They are
  1057. identified by numbers from 1 to 9. You may start, stop and restart the
  1058. timers as necessary.
  1059.  
  1060. Each of the nine possible timers is identified by a number. You can
  1061. read the value of a specific timer into a variable by using the
  1062. timer(n) function in the Expression Editor. This function returns
  1063. elapsed time of a specific timer number in seconds.
  1064.  
  1065. In general it is a good practice to use >= or <= rather than == in
  1066. testing the timer condition, as the timer is not updated at every
  1067. second and it may miss the value while sampling around it. For
  1068. instance, if you state a conditional expression:
  1069.  
  1070.          timer(1) == 10.00
  1071.  
  1072. then the condition might never be True as the timer clock may jump
  1073. from 9.95 seconds to 10.01 seconds and miss the 10.00 second mark
  1074. entirely. Thus it is prudent to use the >= or <=  tests when you state
  1075. conditions using the timers.
  1076.  
  1077. Click on the Start from Zero/Stop/Restart multi-state gadget to select
  1078. the appropriate action. Click on the Timer # gadget to enter the
  1079. number of the timer being used.
  1080.  
  1081.  
  1082. RESOURCE CONTROL
  1083.  
  1084. The Resource Control icon allows you to preload files containing
  1085. pictures, digitized sounds, animations, music, instruments and ASCII
  1086. text into memory for quick use later in the presentation. The Resource
  1087. Control icon also allows you to remove loaded files from memory when
  1088. they are no longer needed. The preloading of useful resources
  1089. generally requires memory of at least 3 megabytes or it will create
  1090. constraints in presenting applications.
  1091.  
  1092. When you click on the Directory gadget, the file requester is
  1093. displayed. Here you may specify the volume, drawer and name of the
  1094. resource files. If you want this file to be entered into the resource
  1095. file list, then click on the Insert gadget to the right of the window.
  1096.  
  1097. To insert a resource in a particular place in the list of existing
  1098. resources in the window, click on the resource below the line where
  1099. you wish to insert it. Then, click on Insert to place the resource
  1100. from the Directory field into the Resource Window.
  1101.  
  1102. To delete a resource from the list, click on the resource. Then click
  1103. on Delete.
  1104.  
  1105. To move a resource elsewhere in the list, click on the resource. Click
  1106. on Move. To move a resource above its original position, click on the
  1107. resource above which you want to move. To move a resource below its
  1108. original position, click on the resource below the line where you want
  1109. to move it to.
  1110.  
  1111. Select the Pause button to cause the application to wait until the
  1112. files are loaded before executing the next icon.
  1113.  
  1114. Select the action by clicking on the Load/Unload Files multi-state
  1115. gadget. Usually when you need to unload previously loaded files, you
  1116. can simply use the Copy feature from the Edit pull-down menu and copy
  1117. the Resource icon that was used to load the files. Selectively delete
  1118. the files that you do not want removed from memory and then select the
  1119. Unload option. This saves you the labor of specifying each of the
  1120. files to be unloaded.
  1121.  
  1122.  
  1123. CONTENT FOLDER
  1124.  
  1125. The Content Folder may contain any number of audiovisual icons. Its
  1126. principal use is for organizing audiovisual information in a
  1127. hierarchical manner. If a picture or sound is likely to be used in
  1128. many different applications, then it is handy to have an archive using
  1129. the content files.
  1130.  
  1131. Use the Content Folder to organize and store commonly used graphics,
  1132. animations, digitized sounds, music, text for speech, text for display
  1133. and videodisc segments for easy insertion into your presentations.
  1134. When you create a new application you can simply copy various elements
  1135. from your content files.
  1136.  
  1137. Just as with the flow window, you can move, copy, preview and save
  1138. audiovisual content icons. But you cannot specify logic using control
  1139. structures or any icons other than audiovisual icons.
  1140.  
  1141.  
  1142.                                DATABASE
  1143.  
  1144. SELECT RECORD
  1145.  
  1146. The Select Record icon opens a database and selects one or more
  1147. records.
  1148.  
  1149. Before selecting records using one or more of the key fields in the
  1150. database, you must define a set of variables containing the values you
  1151. wish to specify as the key fields. If, for example, you want to select
  1152. all the records with the last name Smith you must create a string
  1153. variable: VARNAME="Smith." You can define variables using either the
  1154. Module, Subroutine or Variable icons.
  1155.  
  1156. Using the Select Record icon, first enter the database filename. This
  1157. will open the database and display all the fields highlighting the key
  1158. fields with a > character. You can double-click on the key fields and
  1159. a list of variables will be presented for you to link variables to key
  1160. fields for searching the database.
  1161.  
  1162. If you want to restrict the search to just what is entered, then you
  1163. must terminate your variable value with the | (vertical bar) character
  1164. i.e., VARNAME="Smith|". This will ignore all records with last names
  1165. that do not exactly match Smith. These values are case sensitive.
  1166.  
  1167. The Select Record icon can be a parent to the other database icons
  1168. which perform the read and write operations. As a parent  the Select
  1169. Record icon acts like a loop in that the actions of its children are
  1170. performed repeatedly until all the selected records have been
  1171. processed.
  1172.  
  1173. If you do not link any variables to key fields, the Select Record icon
  1174. selects the very first record in your data file. As a parent it then
  1175. loops through all the data records sequentially. If the Select Record
  1176. icon is not a parent then it selects only the first record for use by
  1177. its siblings.
  1178.  
  1179. Note that you may have as many as ten separate database files open for
  1180. selection in your application. Each of the database files requires a
  1181. separate Select Record icon.  This is useful in a case where you have
  1182. stored the names and addresses in on file and the test scores or other
  1183. vital statistics in another file. By using two separate Select Record
  1184. icons, you can select and read information from both files.
  1185.  
  1186. Click on the Directory gadget to select a database through the file
  1187. requester, or type the database name in the filename field and press
  1188. the Return key.
  1189.  
  1190. The specified file's fields are shown in the window with the key
  1191. fields marked by the > character. Clicking on the field name in the
  1192. list presents a list of variables that have been defined in the flow.
  1193. Select a variable from the list to link it to a field. Repeat this
  1194. procedure for each of the fields you want to link to a variable.  Be
  1195. sure that the variables you are using have been assigned values prior
  1196. to the Select Record icon. When the Select Record icon executes, it
  1197. first located one or more records using the specified key fields and
  1198. then uses the non-key fields, if any, to locate the record precisely.
  1199.  
  1200. If a key field is not assigned a variable, the interpretation is to
  1201. SELECT ALL the records that match that key. If no fields are assigned
  1202. to variables, all records are selected starting from the first one.
  1203.  
  1204. If more than one key field is linked to variables, the interpretation
  1205. is to SELECT ALL the records that match key field 1 and key field 2
  1206. and key field 3 and so on. You are also allowed to use non-key fields
  1207. in addition to the key fields to select records.
  1208.  
  1209. If the Select Record icon fails to find a single record in the
  1210. database that matches the specified keys, then it does not perform the
  1211. actions of its children and the application moves to the next icon. If
  1212. you want to perform specific actions such as adding a new record, then
  1213. you must use variables to determine if the Select Record icon failed
  1214. to locate a record.
  1215.  
  1216.  
  1217. READ/WRITE RECORD
  1218.  
  1219. The Read/Write Record icon is the primary method for reading and
  1220. updating information in a single record in the database. It is also
  1221. used to add new records to the database.
  1222.  
  1223. Specify the name of the database file to be used in the Filename
  1224. field. Be sure that the database file you have specified has been
  1225. opened previously by a Select Record icon. If you do not have a Select
  1226. Record icon defined, then your Read/Write icon will fail to do
  1227. anything.
  1228.  
  1229. Click on the multi-state gadget to select one of three operations:
  1230. Read, Insert or Update a record. Read is used for reading the data
  1231. fields in the currently selected record into the variables that have
  1232. been linked.
  1233.  
  1234. Insert adds new records to the database. You can use it, for instance,
  1235. if the Select Record operation fails to find a record with key fields
  1236. matching key values specified.
  1237.  
  1238. If the operation is an Update, the action updates the values in the
  1239. specified fields of the currently selected record.
  1240.  
  1241. A list of the available fields is shown in the window. Clicking on the
  1242. field name in the list presents a list of previously defined
  1243. variables. You can select variables from this list and link them to
  1244. the fields. The linking operation is identical to that in the Select
  1245. Record icon. It is a good practice to use different variables for
  1246. record selection and for record reading/writing. For instance, you may
  1247. want to use multiple Read/Write icons for  reading the same record
  1248. into different variable in your application.
  1249.  
  1250.  
  1251. DELETE
  1252.  
  1253. Use the Delete icon to remove a record from the database. Records to
  1254. be deleted must first be selected with the Select Record icon.
  1255.  
  1256. Specify the name of the database file to be used in the Filename
  1257. field.
  1258.  
  1259. Once the Select Record icon has selected a record, the Delete icon
  1260. will remove it from the specified database.
  1261.  
  1262.  
  1263. VARIABLES
  1264.  
  1265. You may use the Variables icon to define variables by assigning values
  1266. or expressions to them.
  1267.  
  1268. In AmigaVision, variables can be created using a Module icon, a
  1269. Subroutine icon or the Variables icon. Variables created by Module and
  1270. Subroutine icons are called "local". For instance, a variable defined
  1271. in a Module icon will be useful only within that Module. Similarly a
  1272. variable defined in a Subroutine icon has validity only within that
  1273. Subroutine.
  1274.  
  1275. The Variables icon, in contrast, can create variables that can be used
  1276. throughout an application. Thus they are called "global" variables. In
  1277. addition to creating global variables, the Variables icon can also be
  1278. used for modifying the values of all variables (Global and local).
  1279.  
  1280. In general, when you use the Variables icon if the variables you use
  1281. have not been previously defined, you will be creating global
  1282. variables.
  1283.  
  1284. The Delete, Insert and Move gadgets are used to arrange expressions in
  1285. the Expressions (or variable definitions)  Window. When you click on
  1286. Insert, the Expression Editor is presented and you may define a number
  1287. of variables. When you exit the Expression Editor by clicking on the
  1288. OK gadget, the variables along with their defining expressions will
  1289. appear in the expressions window.
  1290.  
  1291. To insert expressions in a particular place in the list of existing
  1292. expressions in the window, click on the expression above the line
  1293. where you wish to insert the new expression. When the expression is
  1294. highlighted, click on the Insert gadget.
  1295.  
  1296. To delete an expression from the list, click on the expression in the
  1297. window. Then click on the Delete gadget.
  1298.  
  1299. To move an expression elsewhere in the list, click on the expression.
  1300. Click on the Move gadget. To move a variable definition above its
  1301. original position, click on the definition above the line where you
  1302. want to move. To move a variable definition below its original
  1303. position, click on the definition below the line where you want to
  1304. move.
  1305.  
  1306. Double-clicking on a variable definition presents it in the Expression
  1307. Editor for editing.
  1308.  
  1309.  
  1310. OUTPUT
  1311.  
  1312. You may use the Output icon to produce a line of formatted output of
  1313. text or values of variables in your application. The output can be
  1314. sent either to a file or to a printer. If the output is sent to a file
  1315. it is saved in the ASCII format.
  1316.  
  1317. Note that the Output icon allows you to format only a single line of
  1318. output that has a maximum of 132 characters long.  If you need
  1319. multiple lines (for example, to include headings in a report), you
  1320. must use one Output icon for each line.
  1321.  
  1322. Click on the multi-state gadget to specify the output destination:
  1323. Printer or File. If you select File option then an ASCII file is
  1324. created using the specified filename. Specify the name of the output
  1325. file to be used in the Filename field. If a file by that name already
  1326. exists, the output is simply appended to the end of the existing file.
  1327.  
  1328. When you click on the Var gadget the variable list is presented.  When
  1329. you select a variable from the list, it will appear in the Var field.
  1330. When the Output icon is executed the value of this variable will be
  1331. printed at the column location that you specify.
  1332.  
  1333. You have the option of specifying a text string instead of a variable.
  1334. Click on the Text field to type in a literal string of text to be
  1335. output. This is useful for specifying a title, column heading, or
  1336. other fixed textual information on the line to be printed.
  1337.  
  1338. After specifying a variable or a text string to be output you have to
  1339. click on the Column gadget to enter the starting column number for
  1340. printing. The maximum number of columns is 132. You should carefully
  1341. plan the output so that string variables such as names have adequate
  1342. space. Thus you have to allocate all the variable values you want
  1343. shown in a single line over the limited space of 132 columns.
  1344.  
  1345. Click on the Insert gadget to add the specification to the output
  1346. format window. This window shows the starting column location; a code
  1347. letter (T or V) indicating whether at that location a text string or a
  1348. variable value is being printed; and either the name of the variable
  1349. or the text string.
  1350.  
  1351. The Delete, Insert and Move gadgets are used to arrange the output
  1352. format items in the window on the left. The order of items in the list
  1353. does not matter, as the printing occurs according to the specified
  1354. column location.
  1355.  
  1356. To insert a new item at a particular place in the list in the window,
  1357. click on the item above the line where you wish to insert the new
  1358. expression. When the item is highlighted, click on the Insert gadget.
  1359.  
  1360. To delete an item from the list, click on the item and then click on
  1361. the Delete gadget.
  1362.  
  1363. To move an item elsewhere in the list, click on the item and then
  1364. click on the Move gadget. To place the item above its original
  1365. position, click on the item above the line where you want the
  1366. expression to move. To place the item below its original position,
  1367. click on the item below the line where you want the expression to
  1368. move.
  1369.  
  1370. Double-clicking on an item presents it for modification in the Var (or
  1371. Text) and the Column fields.  After modification you must insert it
  1372. again using the Insert gadget and then use the Delete gadget to delete
  1373. the original item.
  1374.  
  1375.  
  1376. DATA FORM
  1377.  
  1378. You use the Data Form icon to create forms on the screen for data
  1379. entry. A data entry form is a screen which contains data fields into
  1380. which the user types information. The data fields for the form are
  1381. created in the Object Editor. In the data field requester, define the
  1382. field type and length.
  1383.  
  1384. In addition to data fields, the form may include hit boxes for
  1385. entering non-field responses. As an example, the form might include
  1386. hit boxes for OK and CANCEL, which could be used to exit the form.
  1387.  
  1388. You can validate the data entered by the user in a form by checking
  1389. each field. The Object Editor lets you specify validation expressions
  1390. and error messages for each field. Alternatively, you may validate the
  1391. data entered in all the fields after the user exits the form. You may
  1392. also specify response strings for exitting and/or aborting a form.
  1393.  
  1394. Click on the Object Editor gadget to enter the object editor. In the
  1395. Object Editor you define the screen appearance and all the data fields
  1396. for the form. For each of the data fields you must specify a variable.
  1397. The data entered by the user in this field is assigned to that
  1398. variable.
  1399.  
  1400. In the Object Editor you can also specify hit boxes for exitting or
  1401. aborting the form.
  1402.  
  1403. Click on the multi-state gadget to specify whether input should be
  1404. validated for each field or when the form is exitted. If you choose
  1405. Validate Fields, the exit condition for each field is checked as the
  1406. data for the field is entered.  If you select Validate on Exit, field
  1407. entries are not validated until the form is exitted.
  1408.  
  1409. Note that if you select Validate on Exit, you must specify a string in
  1410. the Exit On field for the form. This string must match the response
  1411. string you specified for the hit box when you created the data form in
  1412. the Object Editor. Similarly if you want to provide the user an abort
  1413. option in the data form, you must specify a hit box with a response
  1414. string. This same string must then be entered in the Forms requester
  1415. in the field for the Abort On string.
  1416.  
  1417. A form is usually exitted when the user clicks on the hit box with the
  1418. response string specified next to Exit On. The values of variables
  1419. that are linked to the data fields are then modified and saved.
  1420. However, if the Abort condition occurs, ariables are reset to their
  1421. values prior to the Data Form icon.
  1422.  
  1423. Click in the Exit On field and type in the string which will cause the
  1424. form to be exitted. Click in the Abort On field and type in the string
  1425. which will cause the form to be aborted.
  1426.  
  1427.  
  1428. FORM EXIT
  1429.  
  1430. You use the Form Exit icon to exit from a data form without the use of
  1431. a hit box. The Form Exit icon is not required for each Data Form icon.
  1432. Normally, a Data Form icon is exitted when either the Exit On string
  1433. or the Abort On string is encountered.  You may, however, include hit
  1434. boxes for other response strings on the form.  You might then check
  1435. for one these other response strings and conditionally execute other
  1436. icons. The Form Exit icon could then be used to exit the Data Form
  1437. icon.
  1438.  
  1439. Using the multi-state gadget, you may specify the mode as either Exit
  1440. or Abort. If you specify Exit, the variable values adjusted by the
  1441. data fields in the form are modified and saved.  If you choose Abort,
  1442. variable values are reset their values prior to the Data Form icon.
  1443.  
  1444.  
  1445.                                CONTROL
  1446.  
  1447. CALL
  1448.  
  1449. The Call icon references a subroutine. A subroutine  refers to an
  1450. independent segment of the flow that represents a procedure that is
  1451. repeatedly used in an application.
  1452.  
  1453. When you place the Call icon in the outline, a placeholder for the
  1454. partner automatically appears. Double-click on the placeholder to
  1455. begin the referencing process. This process allows you to scroll
  1456. through the flow window and select the specific subroutine icon to be
  1457. referenced.
  1458.  
  1459. During presentation, when the execution of an application reaches the
  1460. Call icon, the referenced subroutine is executed. If either a Return
  1461. icon is encountered within a subroutine or if the subroutine execution
  1462. is completed, the application will continue with the icon following
  1463. the Call icon in the flow outline.
  1464.  
  1465.  
  1466. CONDITIONAL GOTO
  1467.  
  1468. The Conditional Goto icon branches to an icon in another part of the
  1469. outline based on a condition. This icon  conditionally transfers the
  1470. flow of logic from one part of the application to another.
  1471.  
  1472. You define the condition for the branching using the Expression
  1473. Editor. An expression is a simple test that returns either a true or
  1474. false value. If the result is true, the Goto is performed, otherwise
  1475. it is not.
  1476.  
  1477. When you place the Conditional Goto icon in the outline, a placeholder
  1478. for the partner automatically appears. Double-click on the placeholder
  1479. to begin the referencing process. You can now scroll through the flow
  1480. window and select the specific icon for referencing.
  1481.  
  1482. Note the following restrictions on the use of the Conditional Goto:
  1483.  
  1484. 1.  You can only reference icons which are on the same level (or
  1485. vertical column in the flow) or to the left of the icon. But you may
  1486. not use Conditional Goto icons to branch to any icons to the right of
  1487. it in the flow.
  1488.  
  1489. 2.  The Flow Editor will not permit you to branch to an icon that is a
  1490. child of a Loop, Subroutine, Select Record, or Interrupt icon.
  1491. However, you can branch to a parent Loop, Interrupt, or Select Record
  1492. icon.
  1493.  
  1494. During presentation, if the specified condition is true, the
  1495. application branches to the referenced icon and continues from that
  1496. point. If the condition is false, the icon following the Conditional
  1497. Goto is executed.
  1498.  
  1499. The Conditional Goto icon offers a powerful way of creating  branching
  1500. in flow. But be careful while using it, as you may unintentionally
  1501. create an infinite loop.
  1502.  
  1503.  
  1504. GOTO
  1505.  
  1506. The Goto icon unconditionally branches or transfers control of flow to
  1507. an icon in another part of the outline.
  1508.  
  1509. When you place the Goto icon in the outline, a placeholder for the
  1510. partner automatically appears. Double-click on the placeholder which
  1511. allows you to scroll through the flow window and select the specific
  1512. icon to be referenced.
  1513.  
  1514. Note the following restrictions on the use of the Goto:
  1515.  
  1516. 1.  It can only reference icons which are on the same level (or
  1517. vertical column in the flow) or to the left of the icon. You cannot
  1518. use Goto icons to branch to any icons to the right of it.
  1519.  
  1520. 2.  The Flow Editor will not permit you to branch to an icon that is a
  1521. child of a Loop, Subroutine, Select Record or Interrupt icon. However,
  1522. you can branch to a parent Loop, Interrupt or Select Record icon.
  1523.  
  1524. During presentation, when the application reaches the Goto icon, it
  1525. unconditionally branches to the referenced icon and continues from
  1526. that point.
  1527.  
  1528. Use care, as it is possible to create an unintentional infinite loop
  1529. with this icon.
  1530.  
  1531.  
  1532. LOOP
  1533.  
  1534. The Loop icon creates a set of actions to be taken indefinitely, until
  1535. a certain condition is true or a set number of times. The Loop icon is
  1536. important for repeating a set of actions.
  1537.  
  1538. Clicking on the multi-state gadget below the Memo field cycles through
  1539. the available loop types: Endless, Counted and Conditional.
  1540.  
  1541. An Endless loop needs no other specifications. It simply runs
  1542. continuously until interrupted by an interrupt event or a Loop Exit
  1543. icon. If an interrupt event occurs, the loop will resume where it was
  1544. interrupted after the interrupting event is completed. The Loop Exit
  1545. icon lets you permanently exit a loop and proceed to the icon
  1546. following the Loop icon. You can also use either a Conditional Goto or
  1547. Goto icon to exit a loop and branch to a specific location in the
  1548. flow.
  1549.  
  1550. A Counted loop needs three parameters:  numeric values for Start,
  1551. Step, and Stop. These values can either be positive or negative
  1552. integers or defined by variables. The Counter variable Var is an
  1553. option in which you can specify a variable name for use within the
  1554. loop. The value of the variable will be incremented from the Start
  1555. value by increments of Step. The value of the loop variable can be
  1556. used in other expressions in the loop.
  1557.  
  1558. Start is the initial value of the counter, and Stop is the final
  1559. value. AmigaVision performs the actions of all the icons that are part
  1560. of the Loop, then adjusts the value of the counter by the amount
  1561. specified by Step.
  1562.  
  1563. You may enter either numeric values or variables to specify Start,
  1564. Stop, and Step by clicking on their respective gadgets.
  1565.  
  1566. The variable specified for Var is useful if you wish to evaluate
  1567. expressions within the loop that change during each cycle of the loop.
  1568.  
  1569. When a Conditional loop has been selected, the Test at Start/Test at
  1570. End gadget becomes active. Conditional (Test at Start) refers to a
  1571. condition which is checked at the beginning of each loop cycle and
  1572. which will end the loop if false.  Conditional (Test at End) is the
  1573. same except the condition is checked at the end of each loop cycle.
  1574. The loop continues to execute until the specified condition is no
  1575. longer true.
  1576.  
  1577. The expression you create in the Expression Editor will appear in the
  1578. text box below the Conditional (Test at) gadget after you exit the
  1579. editor.
  1580.  
  1581.  
  1582. LOOP EXIT
  1583.  
  1584. The Loop Exit icon is used to cause a loop to end, and the application
  1585. to continue with the icon following the loop.
  1586.  
  1587. During presentation, when the application reaches the Loop Exit icon,
  1588. the loop is terminated and the action of the Loop's next sibling is
  1589. performed. The Loop Exit icon is ignored if it is placed outside of a
  1590. loop.
  1591.  
  1592. Another way to exit a loop is to use the Conditional Goto or Goto icon
  1593. to branch out of the loop.
  1594.  
  1595.  
  1596. IF-THEN
  1597.  
  1598. The If-Then icon tests to see if a condition is true, and if it is,
  1599. performs the actions of its partner icon. The partner icon is placed
  1600. directly to the right of the If-Then icon.
  1601.  
  1602. You define the condition for the If-Then icon using the Expression
  1603. Editor. An expression is a simple test that returns either a true or
  1604. false value. If the result is true, the partner is performed,
  1605. otherwise it is not.
  1606.  
  1607. If you would like to place more than one icon as the partner of the
  1608. If-Then icon, place a Module as the partner. If the condition is true,
  1609. all the child icons of the Module will be performed.
  1610.  
  1611. You may not place another partner-dependent icon as the partner of an
  1612. If-Then. To execute a Call, Goto, Conditional Goto, If-Then or If-
  1613. Then-Else icon as the partner of an If-Then icon it must be placed as
  1614. the child of a module icon.
  1615.  
  1616.  
  1617. IF-THEN-ELSE
  1618.  
  1619. The If-Then-Else icon tests to see if a condition is true, and if it
  1620. is, performs the actions of its partner icon. If the condition is
  1621. false, it performs the actions of the icon directly below it. The
  1622. partner icon is placed directly to the right of the If-Then-Else icon.
  1623.  
  1624. You define the condition for the If-Then-Else using the Expression
  1625. Editor. An expression is a simple test that returns either a true or
  1626. false value. If the result is true, the partner is performed,
  1627. otherwise the icon directly below the if-Then-Else is performed.
  1628.  
  1629. If you would like to place more than one icon as the partner of the
  1630. If-Then-Else icon, place a Module icon as the partner. If the
  1631. condition is true, all the child icons of the Module icon will be
  1632. performed.
  1633.  
  1634. You may not place another partner-dependent icon as the partner of an
  1635. If-Then-Else. To execute a Call, Goto, Conditional Goto, If-Then or
  1636. If-Then-Else icon as the partner of an If-Then-Else it must be placed
  1637. as the child of a Module icon.
  1638.  
  1639. You can test multiple conditions by using subsequent If-Then-Else
  1640. icons. If you would like to test for three different possible
  1641. response() values you would place the first If-Then-Else and set the
  1642. condition to response()=="firstchoice".  Directly below it, as the
  1643. Else result, place another If-Then-Else with a condition of
  1644. response()=="secondchoice". Finally place a simple If-Then to test for
  1645. response()=="thirdchoice".
  1646.  
  1647. End.
  1648.